Player Module/com.bitmovin.player.api.advertising

Package com.bitmovin.player.api.advertising

Contains API to enable advertising workflows.

Types

Link copied to clipboard
interface Ad
Content copied to clipboard

Defines basic properties available for every ad type

Link copied to clipboard
interface AdBreak : AdConfig
Content copied to clipboard

Contains information about an ad break.

Link copied to clipboard
interface AdBreakConfig : AdTagConfig
Content copied to clipboard

Contains configuration options for an AdBreak.

Link copied to clipboard
interface AdConfig
Content copied to clipboard

Contains the base configuration options for an ad.

Link copied to clipboard
interface AdData
Content copied to clipboard

Holds various additional ad data. Refer to ImaAdData for more information on what additional data is available when using the Google IMA SDK implementation.

Link copied to clipboard
data class AdItem(sources: Array<AdSource>, position: String, replaceContentDuration: Double, preloadOffset: Double) : Parcelable
Content copied to clipboard

Represents an ad break which can be scheduled for playback.

Link copied to clipboard
enum AdQuartile
Content copied to clipboard
Quartiles that can be reached during an ad playback.
Link copied to clipboard
interface AdsManagerAvailableCallback
Content copied to clipboard
Can be implemented to gain access to the currently used IMA AdsManager.
Link copied to clipboard
data class AdSource(type: AdSourceType, tag: String) : Parcelable
Content copied to clipboard

Represents an ad source which can be assigned to an AdItem. An AdItem can have multiple AdSources as waterfalling option.

Link copied to clipboard
enum AdSourceType : Enum<AdSourceType> , Parcelable
Content copied to clipboard

The available types an AdSource can have.

Link copied to clipboard
class AdTag(url: String, type: AdTagType)
Content copied to clipboard

Defines the url and type of an ad manifest.

Link copied to clipboard
interface AdTagConfig : AdConfig
Content copied to clipboard

Contains configuration options for an AdTag.

Link copied to clipboard
enum AdTagType : Enum<AdTagType>
Content copied to clipboard

Types that can be specified for an AdTag.

Link copied to clipboard
data class AdvertisingConfig(schedule: List<AdItem>, companionAdContainers: List<CompanionAdContainer>?, adsManagerAvailableCallback: AdsManagerAvailableCallback?, beforeInitialization: BeforeInitializationCallback?, imaUiElements: List<ImaUiElement>?) : Parcelable
Content copied to clipboard

Contains configuration values regarding the ads which should be played back by the player.

Link copied to clipboard
interface BeforeInitializationCallback
Content copied to clipboard
A callback to be invoked before IMA initialization, exposing the IMA settings
Link copied to clipboard
data class CompanionAdContainer(container: ViewGroup, width: Int, height: Int)
Content copied to clipboard
Link copied to clipboard
interface LinearAd : Ad
Content copied to clipboard

Defines a linear ad which requires the playback of the content to stop

Link copied to clipboard
interface OverlayAd : Ad
Content copied to clipboard

Defines an ad which gets displayed during content playback